How to contribute
=================
A complete technical description of the project is available
in the documentation. You can find latest version of the documentation online
at http://fltube.org/docs (**WIP**) or generate docs yourself.

Generating documentation
------------------------
We use Doxygen(1) to write documentation and ax_prog_doxygen(2)
to integrate the documentation generation process
into the Automake(3) project.

Follow these steps to generate documentation:
1. Configure the project:
   ```sh
   ./autogen.sh
   ./configure
   ```
2. Generate the documentaiton:
   ```sh
   make doxygen-doc
   ```

By default, Doxygen generates HTML and PDF documentation.

You can change this by specifying flags like this:
`-<enable|disable>-doxygen-<format>`

For example:
`-disable-doxygen-html` disables HTML format.
`-enable-doxygen-xml` enables XML format.

List of supported formats:
* DOT
* HTML
* CHM
* CHI
* MAN
* RTF
* XML
* PDF
* PS

See ax_prog_doxygen(2) for details.

You can now find the generated documentation in the `docs/dist`

Links
-----
1. Doxygen:         http://www.doxygen.nl
2. ax_prog_doxygen: http://www.gnu.org/software/autoconf-archive/ax_prog_doxygen.html
3. Automake:        http://www.gnu.org/software/automake
